MarkLogic 9 Product DocumentationGET /manage/v2/databases/{id|name}?view=package
Summary
This resource address returns configuration details about the named database in
a format suitable for use with the /manage/v2/packages interfaces. The database
can be identifed either by id or name.
| URL Parameters | |
|---|---|
| format | The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present. |
| Request Headers | |
|---|---|
| Accept | The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.
Required Privileges
This operation requires one of the following:- the
manage-userrole - the following privilege:
http://marklogic.com/xdmp/privileges/manage - the
managerole plus one of the following granular privileges:http://marklogic.com/xdmp/privileges/admin/database/database-IDhttp://marklogic.com/xdmp/privileges/admin/database/activity/database-ID
where activity is one of the following:
- backup
- merge
- restore
- clear
- index
Usage Notes
You can request a package view as HTML, XML, or JSON, but only the XML and JSON formats can be used as input to the/manage/v2/packages interfaces, such as
POST /manage/v2/packages/{pkgname}. Example
http://localhost:8002/manage/v2/databases/Documents?view=package
==> Returns the package representation of the Documents database
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.